/*
 *  Copyright (C) 2010 glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.application;

import org.balisunrise.common.VisualEntity;

/**
 * Manipula a exibição de das representações visuais das VisualEntity do
 * aplicativo.
 * Esta classe também é a Factory de Window, criando suas instâncias.
 *
 * @author Glauco
 */
public interface WindowsManager {

    /**
     * É criado e exibida uma Window para exibição da representação visual.<br>
     * <br><i>Por exemplo, se for utilizado a API do swing para implementação
     * das representações visuais das entidades, os objetos de Window podem ser
     * JDialog, JFrame, JWindow. No caso de Utilizar o NetBeans Plataform
     * a Window pode ser um TopComponent.</i><br><br>
     * O Método só retorna após o fim da exibição da Window.
     * @return A Window criada e exibida.
     * @param visualEntity VisualEntity a ser exibida.
     */
    public Window showVisualEntity(VisualEntity visualEntity);

    /**
     * É criado uma Window para exibição da representação visual.<br>
     * @param visualEntity VisualEntity a ser exibida.
     * @return A Window criada.
     */
    public Window createWindow(VisualEntity visualEntity);

    /**
     * É exibida uma Window para exibição da representação visual.<br>
     * O Método só retorna após o fim da exibição da Window.
     * @param window Window para ser exibida.
     */
    public void showWindow(Window window);

    /**
     * Retorna o objeto Window exibido atualmente, o qual é utilizado para
     * mostrar a representação visual de alguma entidade.<br><br><i>
     * Por exemplo, se for utilizado a API do swing para implementação
     * das representações visuais das entidades, os objetos de Window podem ser
     * JDialog, JFrame, JWindow. No caso de Utilizar o NetBeans Plataform
     * a Window pode ser um TopComponent.</i><br>
     * 
     * @return Window exibido.
     */
    public Window getActiveWindow();

    /**
     * Retorna as instâncias de Windows abertas, visiveis.
     */
    public Window[] getWindows();
 }
